/*
 * Copyright (c) 2012, marco.tamburelli@gmail.com
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met: 
 * 
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer. 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 * The views and conclusions contained in the software and documentation are those
 * of the authors and should not be interpreted as representing official policies, 
 * either expressed or implied, of the CometMI Project.
 */
package org.cometmi.gwt.client;

import java.util.List;

import org.cometmi.gwt.shared.request.Call;
import org.cometmi.gwt.shared.request.FreeRequestBean;
import org.cometmi.gwt.shared.request.ListenRequestBean;
import org.cometmi.gwt.shared.request.PublishRequestBean;
import org.cometmi.gwt.shared.request.QueueRequestBean;
import org.cometmi.gwt.shared.request.ResponseStatus;

import com.google.gwt.user.client.rpc.RemoteService;

/**
 * The main service to enable the communication between client and server.
 * 
 * @author marco.tamburelli@gmail.com
 */
public interface CometMiService extends RemoteService
{
	/**
	 * Publishes a method invocation request.
	 * 
	 * @param publishRequest The request.
	 */
	ResponseStatus publish(PublishRequestBean publishRequest);

	/**
	 * Publish a listen request, and provides pushed method invocation when
	 * available.
	 * 
	 * @param listenRequest The request
	 * @return The list of method invocations retrieved during a poll.
	 */
	List<Call> listen(ListenRequestBean listenRequest);

	/**
	 * Send to the server a queue free request.
	 * 
	 * @param freeRequest The request
	 */
	void freeQueue(FreeRequestBean freeRequest);

	/**
	 * This method returns the status of availability of the requested queue.
	 * This method is required to initialize the listening.
	 * 
	 * @param queueRequest The bean containing queue request parameters.
	 * @return The response status.
	 */
	ResponseStatus checkQueueAvailability(QueueRequestBean queueRequest);

	void setQueueAttribute(String queueName, String key, String value);

	String getQueueAttribute(String queueName, String key);

	String removeQueueAttribute(String queueName, String key);

	/**
	 * Empty method to test the server connection.
	 */
	void checkConnection();
}
